estuary_client.DealsApi

All URIs are relative to //api.estuary.tech/

Method	HTTP request	Description
deal_estimate_post	POST /deal/estimate	Estimate the cost of a deal
deal_info_dealid_get	GET /deal/info/{dealid}	Get Deal Info
deal_proposal_propcid_get	GET /deal/proposal/{propcid}	Get Proposal
deal_query_miner_get	GET /deal/query/{miner}	Query Ask
deal_status_by_proposal_propcid_get	GET /deal/status-by-proposal/{propcid}	Get Deal Status by PropCid
deal_status_miner_propcid_get	GET /deal/status/{miner}/{propcid}	Deal Status
deal_transfer_in_progress_get	GET /deal/transfer/in-progress	Transfer In Progress
deal_transfer_status_post	POST /deal/transfer/status	Transfer Status
deals_failures_get	GET /deals/failures	Get storage failures for user
deals_make_miner_post	POST /deals/make/{miner}	Make Deal
deals_status_deal_get	GET /deals/status/{deal}	Get Deal Status
public_deals_failures_get	GET /public/deals/failures	Get storage failures
public_miners_storage_query_miner_get	GET /public/miners/storage/query/{miner}	Query Ask

deal_estimate_post

str deal_estimate_post(body)

Estimate the cost of a deal

This endpoint estimates the cost of a deal

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.DealsApi(estuary_client.ApiClient(configuration))
body = estuary_client.ApiEstimateDealBody() # ApiEstimateDealBody | The size of the deal in bytes, the replication factor, and the duration of the deal in blocks

try:
    # Estimate the cost of a deal
    api_response = api_instance.deal_estimate_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DealsApi->deal_estimate_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	ApiEstimateDealBody	The size of the deal in bytes, the replication factor, and the duration of the deal in blocks

Return type

str

Authorization

bearerAuth

HTTP request headers

• Content-Type: /
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deal_info_dealid_get

str deal_info_dealid_get(dealid)

Get Deal Info

This endpoint returns the deal info for a deal

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.DealsApi(estuary_client.ApiClient(configuration))
dealid = 56 # int | Deal ID

try:
    # Get Deal Info
    api_response = api_instance.deal_info_dealid_get(dealid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DealsApi->deal_info_dealid_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
dealid	int	Deal ID

Return type

str

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deal_proposal_propcid_get

str deal_proposal_propcid_get(propcid)

Get Proposal

This endpoint returns the proposal for a deal

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.DealsApi(estuary_client.ApiClient(configuration))
propcid = 'propcid_example' # str | Proposal CID

try:
    # Get Proposal
    api_response = api_instance.deal_proposal_propcid_get(propcid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DealsApi->deal_proposal_propcid_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
propcid	str	Proposal CID

Return type

str

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deal_query_miner_get

str deal_query_miner_get(miner)

Query Ask

This endpoint returns the ask for a given CID

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.DealsApi(estuary_client.ApiClient(configuration))
miner = 'miner_example' # str | CID

try:
    # Query Ask
    api_response = api_instance.deal_query_miner_get(miner)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DealsApi->deal_query_miner_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
miner	str	CID

Return type

str

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deal_status_by_proposal_propcid_get

str deal_status_by_proposal_propcid_get(propcid)

Get Deal Status by PropCid

Get Deal Status by PropCid

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.DealsApi(estuary_client.ApiClient(configuration))
propcid = 'propcid_example' # str | PropCid

try:
    # Get Deal Status by PropCid
    api_response = api_instance.deal_status_by_proposal_propcid_get(propcid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DealsApi->deal_status_by_proposal_propcid_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
propcid	str	PropCid

Return type

str

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deal_status_miner_propcid_get

str deal_status_miner_propcid_get(miner, propcid)

Deal Status

This endpoint returns the status of a deal

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.DealsApi(estuary_client.ApiClient(configuration))
miner = 'miner_example' # str | Miner
propcid = 'propcid_example' # str | Proposal CID

try:
    # Deal Status
    api_response = api_instance.deal_status_miner_propcid_get(miner, propcid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DealsApi->deal_status_miner_propcid_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
miner	str	Miner
propcid	str	Proposal CID

Return type

str

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deal_transfer_in_progress_get

str deal_transfer_in_progress_get()

Transfer In Progress

This endpoint returns the in-progress transfers

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.DealsApi(estuary_client.ApiClient(configuration))

try:
    # Transfer In Progress
    api_response = api_instance.deal_transfer_in_progress_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DealsApi->deal_transfer_in_progress_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

str

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deal_transfer_status_post

str deal_transfer_status_post(body)

Transfer Status

This endpoint returns the status of a transfer

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.DealsApi(estuary_client.ApiClient(configuration))
body = estuary_client.ApiChannelIDParam() # ApiChannelIDParam | Channel ID

try:
    # Transfer Status
    api_response = api_instance.deal_transfer_status_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DealsApi->deal_transfer_status_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	ApiChannelIDParam	Channel ID

Return type

str

Authorization

bearerAuth

HTTP request headers

• Content-Type: /
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deals_failures_get

str deals_failures_get()

Get storage failures for user

This endpoint returns a list of storage failures for user

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.DealsApi(estuary_client.ApiClient(configuration))

try:
    # Get storage failures for user
    api_response = api_instance.deals_failures_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DealsApi->deals_failures_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

str

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deals_make_miner_post

str deals_make_miner_post(body, miner)

Make Deal

This endpoint makes a deal for a given content and miner

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.DealsApi(estuary_client.ApiClient(configuration))
body = 'body_example' # str | Deal Request
miner = 'miner_example' # str | Miner

try:
    # Make Deal
    api_response = api_instance.deals_make_miner_post(body, miner)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DealsApi->deals_make_miner_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	str	Deal Request
miner	str	Miner

Return type

str

Authorization

bearerAuth

HTTP request headers

• Content-Type: /
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deals_status_deal_get

str deals_status_deal_get(deal)

Get Deal Status

This endpoint returns the status of a deal

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.DealsApi(estuary_client.ApiClient(configuration))
deal = 56 # int | Deal ID

try:
    # Get Deal Status
    api_response = api_instance.deals_status_deal_get(deal)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DealsApi->deals_status_deal_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
deal	int	Deal ID

Return type

str

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

public_deals_failures_get

str public_deals_failures_get()

Get storage failures

This endpoint returns a list of storage failures

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.DealsApi(estuary_client.ApiClient(configuration))

try:
    # Get storage failures
    api_response = api_instance.public_deals_failures_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DealsApi->public_deals_failures_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

str

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

public_miners_storage_query_miner_get

str public_miners_storage_query_miner_get(miner)

Query Ask

This endpoint returns the ask for a given CID

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.DealsApi(estuary_client.ApiClient(configuration))
miner = 'miner_example' # str | CID

try:
    # Query Ask
    api_response = api_instance.public_miners_storage_query_miner_get(miner)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DealsApi->public_miners_storage_query_miner_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
miner	str	CID

Return type

str

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]